gh-138072: Small clarifications and phrasing improvements to asyncio HOWTO#138073
gh-138072: Small clarifications and phrasing improvements to asyncio HOWTO#138073willingc merged 16 commits intopython:mainfrom
Conversation
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
|
A Python core developer has requested some changes be made to your pull request before we can consider merging it. If you could please address their requests along with any other requests in other reviews from core developers that would be appreciated. Once you have made the requested changes, please leave a comment on this pull request containing the phrase |
|
I think all requested changes have been addressed in this PR, besides modifications to the For ease of reference, the style guide says: "In the Python documentation, the use of sentence case in section titles is preferable, but consistency within a unit is more important than following this rule.". Additionally, I think the use of "preferable" above implies there can be reasonable cases that ignore this guidance. I personally prefer the titles as they are now, for the reasons enumerated here. With that in mind, I wonder if leaving them as is would be amenable for folks? |
|
Please do rename them to "Awaiting tasks" and "Awaiting coroutines".
That's referring to the The next sentence of the devguide:
Well, the rest is already in sentence case, let's stick to it. |
|
For reference, I interpreted the style guide as providing some leeway and more generally I think it can make sense to sometimes ignore strict adherence to style guides, in this case, for the sake of content/flow. Either way, it seems my arguments fell short and failed to sway minds! I'll go ahead and change the section titles as requested. P.S. The same idea regarding |
|
Hey folks, I believe all comments have now been addressed. @willingc, @kumaraditya303, @ZeroIntensity would you mind taking another pass? |
| Then, the event loop needs to manage its internal state and work through | ||
| its processing logic to resume the next job. | ||
| That might sound minor, but in a large program with many ``await``\ s, that | ||
| overhead can add up to a meaningful performance drag. |
There was a problem hiding this comment.
I think "meaningful" has a positive connotation here, which we don't want. How about this?
| overhead can add up to a meaningful performance drag. | |
| overhead can add up to a major performance drag. |
There was a problem hiding this comment.
Just to make sure I understand, the concern is that "meaningful" has a positive connotation, which may confuse a reader into thinking we're saying a "performance drag" is a good thing, yeah?
I think "major" would be overstating the effect. The goal was to describe something that's non-trivial or non-negligible. For what it's worth, I think "meaningful" can be used either way e.g. "a meaningful decline in sales", "a meaningful improvement in test scores", etc. Regardless, would switching to "non-trivial" be amenable?
There was a problem hiding this comment.
To me, "non-trivial" would imply "complex", which doesn't really fit here. I'd prefer "non-negligible".
|
@kumaraditya303, I believe this PR was modified to address your requested changes. Could you update that "requested changes" status so we can unblock this PR? |
|
@ZeroIntensity, @willingc - Would y'all mind giving this another pass or approving if it looks good? :) |
willingc
left a comment
There was a problem hiding this comment.
Thanks @anordin95. I'm going to go ahead and merge. 🎉
…yncio HOWTO (python#138073) * - Small clarifications and phrasing improvements * nit * Apply suggestions from code review Co-authored-by: Peter Bierma <zintensitydev@gmail.com> * clarify event loops when multi threading. * nit * Update Doc/howto/a-conceptual-overview-of-asyncio.rst Co-authored-by: Peter Bierma <zintensitydev@gmail.com> * nit * nit * phrasing for threads & event loops. * revert changes to event-loop/thread discussion. * sentence case consistencty. * slight re-arrange. * Sentence case consistency. * tweak language. non-negligible --------- Co-authored-by: Peter Bierma <zintensitydev@gmail.com>
…yncio HOWTO (python#138073) * - Small clarifications and phrasing improvements * nit * Apply suggestions from code review Co-authored-by: Peter Bierma <zintensitydev@gmail.com> * clarify event loops when multi threading. * nit * Update Doc/howto/a-conceptual-overview-of-asyncio.rst Co-authored-by: Peter Bierma <zintensitydev@gmail.com> * nit * nit * phrasing for threads & event loops. * revert changes to event-loop/thread discussion. * sentence case consistencty. * slight re-arrange. * Sentence case consistency. * tweak language. non-negligible --------- Co-authored-by: Peter Bierma <zintensitydev@gmail.com>

📚 Documentation preview 📚: https://cpython-previews--138073.org.readthedocs.build/en/138073/howto/a-conceptual-overview-of-asyncio.html#a-conceptual-overview-of-asyncio